Platform Explorer / Nuxeo Platform 2021.47

Operation Workflow.GetOpenTasks (Get open tasks)

Description

Returns all open tasks for the input document(s). If the operation is invoked with parameters, all tasks instances for the given 'processId' originating from the given 'nodeId' are returned. The 'processId' is the id of the document representing the workflow instance. The parameter 'username' is used to fetch only tasks assigned to the given user. Tasks are queried using an unrestricted session.
Operation id Workflow.GetOpenTasks
AliasesContext.GetOpenTasks
Category Workflow Context
Label Get open tasks
Requires Workflow
Since

Parameters

Name Description Type Required Default value
nodeId string no  
processId string no  
username string no  

Signature

Inputs document, documents
Outputs documents, documents

Implementation Information

Implementation Class Class: org.nuxeo.ecm.platform.routing.core.api.operation.GetOpenTasksOperation
Contributing Component org.nuxeo.ecm.platform.routing.operations

JSON Definition

{
  "id" : "Workflow.GetOpenTasks",
  "aliases" : [ "Context.GetOpenTasks" ],
  "label" : "Get open tasks",
  "category" : "Workflow Context",
  "requires" : "Workflow",
  "description" : "Returns all open tasks for the input document(s). If the operation is invoked with parameters, all tasks instances for the given 'processId' originating from the given 'nodeId' are returned. The 'processId' is the id of the document representing the workflow instance. The parameter 'username' is used to fetch only tasks assigned to the given user. Tasks are queried using an unrestricted session.",
  "url" : "Workflow.GetOpenTasks",
  "signature" : [ "document", "documents", "documents", "documents" ],
  "params" : [ {
    "name" : "nodeId",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "processId",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "username",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}